ReadMe for ModemProdder 1.15 (18 Nov 1997)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1. What is it?

	Basically, ModemProdder (the prodder) is a simple desktop task
	that monitors the serial port status and gives you the option to
	'prod' your modem back awake if it seems to have 'gone to sleep'.



2. How do I Install it?

	There are two versions of the prodder supplied: a standalone
	application, and a VIX module for use with Voyager.  You only need
	one of these, although nothing nasty will happen if you, say, run the
	standalone version when the VIX one is active.

2.1 Installing the Standalone Version

	Simply copy it (ie. !ModemProd) to your harddisc!  When you connect to
	the internet, run the application by double clicking on it.

	To quit the prodder, either quit it from the Task Manager's Tasks
	window, or (more premanently) type *rmkill modemprodder.

2.2 Installing the VIX Version

	Run !Voyager, and select "VIX Manager..." from the Preferences menu.
	Drag the ModemProd data file to the large square at the top-right of
	the VIX manager window (it has a white arrow pointing at the word
	"ViX").

	Now, whenever you connect to the internet Voyager will automatically
	run the prodder.  When Voyager it quit, it will also quit the prodder.



3. The Prodder in Action

	If the prodder detects that the modem has gone to sleep, it will open
	a small window in the center of the screen to tell you.  This window
	has a 'Prod Modem' button - click on this to try to 'prod' the modem
	awake again.  The window also has a close icon - click on this to
	ignore the message (but if the modem remains asleep, the window will
	re-open in about 10 seconds).

	If the modem should wake up whilst the window is open, the prodder will
	automatically close the window.


4. Technical Details

	The method the prodder uses to test whether the modem is awake or not
	is to check the serial transmit buffer periodically, and if this buffer
	remains at any (non-full or -empty) level consistently for a period of
	(just over) 10 seconds, the prodder decides that the modem has gone to
	sleep.

	The actual prod is done by using OS_SerialOp to send a break to the
	modem.



5. Compatibility

	Because of the way that the prodder works, I don't know if it will
	work with serial cards, etc.  It does however work with the internal
	serial port.


6. Credits, etc.

	The prodder is a complete re-code of an original BASIC program by
	Scott Inwood.  Some time ago, Scott posted a request in one of the
	Argo newsgroups asking if someone wanted to re-code the program in
	assembler to make it more efficient.  The prodder is this re-code.

	So, thanks to Scott for the original idea, and the prompting to
	actually do something with it :)


7. Contact

	I can be contacted as musus@argonet.co.uk and my web pages are at
	http://www.argonet.co.uk/users/musus/ (the web pages contain several
	other apps and patches, etc).


(c) Musus Umbra 1997,1998

Permission is granted for unlimited personal use & modification.

Permission is granted for redistribution (by any method) provided that:
	No charge is made for this software.  A reasonable charge may be
		made for media / handling / etc. This software is *free*.
	Any distributed copy of this software must be unaltered and entire.
		You may not distribute modified / imcomplete copies of this
		software.  If you fix a bug / add a feature, let me know so
		that I can update the master copy.

As usual with freeware, there is no warranty of any kind.  The author cannot
be help responsible for any loss/damage arising from the use/inability to
use this software.  It is the user's responsibility to determine the fitness
of this software for any purpose they put it to.

(But if it doesn't work, I will try to help :-)
